home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Various / S.N.A.G. Disk of the Month 91-03 (1991)(Southern Nevada Amiga Group)(PD).zip / S.N.A.G. Disk of the Month 91-03 (1991)(Southern Nevada Amiga Group)(PD).adf / Triple-Yacht-Z / Triple-Yacht-Z.Docs < prev    next >
Text File  |  1991-03-29  |  23KB  |  544 lines
  1.                 Triple Yacht-Z
  2.  
  3.                   Version 1.2
  4.             
  5.     Copyright 1991 By Stephan Iannce, and Iannce Bros. Software
  6.                  (All Rights Reserved)
  7.  
  8. DISCLAIMER: If you use then program and are injured by it in anyway (maybe
  9.         you got a virus infected copy or your girl-friend throws a book
  10.         and at your head because you spend more time playing this game
  11.         than you spend with her) then I am truly sorry, but I can't 
  12.         take any responsibility for this program. You use it at your
  13.         own risk. Besides I'm just a starving student and you wouldn't
  14.         make any money off of suing me anyways.
  15.         
  16. ADDITIONAL DISCLAIMER: I am not an English Major or Typist Major (I'm a 
  17.                Computer Engineering Major), so any mispelings, 
  18.                Typoos, or there be bad grammar, or, even bad, 
  19.                punctuation; are obviously intentional just to get
  20.                attention.
  21.         
  22. I'll consider this FreeWare since I don't plan on supporting it enough to
  23. make it shareware, although if you enjoy and use it it wouldn't hurt to
  24. send me a little donation ($5 or so) as I'm a starving student...
  25.  
  26. You can do pretty much whatever you want with this program and it won't 
  27. bother me too much. If you include it in some commercial venture 
  28. (yeah right!) it'd be nice to send me a copy of whatever it was included
  29. in. It would also be appreciated if you kept this file along with the 
  30. executable.
  31.  
  32. Triple Yacht-Z is my first "released" program, (I usually don't get around
  33. to finishing the projects I start... :-() so if it isn't that great, then
  34. I'm sorry, but it's cheap! It was written in Lattice C 5.04, and based upon
  35. a game I enjoyed on a Mac II.
  36.  
  37. I've got the source code and wouldn't mind sharing it except that it is
  38. pretty bad, (Although I think I got rid of that goto I used which wasn't
  39. part of error handling... :-) ) especially the computer opponent code. I
  40. can almost safely say it isn't really commented, but shouldn't be too tough
  41. to read through (I use fairly descriptive variable names.) What I'm trying 
  42. to say is I'm not proud of the code (although I am of the results) but hey
  43. it works! If you REALLY want the source code you have 2 options. Either 
  44. request I send it valid internet address, or send me a disk and SASM
  45. (Self Addressed Stamped Mailer) so all I have to do is copy the code onto
  46. the disk and drop it in the mail.
  47.  
  48.  
  49.                 
  50.                        FILES USED
  51.     (Files with an * are not included in the distribution archive!)
  52.  
  53. ty (or whatever you've called the main executable)
  54.  
  55. ty.info - Triple Yacht-Z icon (I won't use it! CLI for me, I just included
  56.           it for those of you who use Workbench.)
  57.  
  58. YachtZ.snd - This is the Digitized sound of some jerk (me) yelling Yacht-Z
  59.          You can change this sound by renaming your own uncompressed
  60.          iff sound file here. So if you want to hear yourself (instead
  61.          of me) yelling Yacht-Z go for it!
  62.          
  63. Dice.Snd - Digitized sound of Dice rolling. You can change this one to. If
  64.        Triple Yacht-Z is unable to find this file ALL SOUND will be 
  65.        turned off for the duration of the game! (The sound menu option
  66.        will be disabled.) This is because this sample is used so often
  67.        I load it into memory at the start.
  68.         
  69. ty.doc - This file!
  70.         
  71. ty.prefs - This is a preferences file that will be loaded at run-time 
  72.        unless Triple Yacht-Z is invoked with the -p switch. This
  73.        file contains entries for Color Values and locations of
  74.        windows. See the PREFERENCES section for details on how to
  75.        create your own preference file. A sample ty.prefs file is
  76.        included in the distribution archive.
  77.  
  78. req.library - Colin Fox and Bruce Dawson's Requester Library. Let me say it
  79.           save a heck of a lot of work! Place this in your libs: 
  80.           directory if you want to be able to use it!
  81.  
  82. *ty.high1 - This is the high score file for Single Yacht-Z. If there is
  83.         none Triple Yacht-Z will create it for you. (Isn't that nice?)                          
  84.  
  85. *ty.high3 - This file behaves just like ty.high1 except it's for Triple
  86.         Yacht-Z!
  87.  
  88. *ty.match - Holds the information for the last saved match
  89.  
  90.  
  91.                     
  92.                STARTING THE THING
  93.                 
  94. If you want to use the color requestors and the load/save match requesters,
  95. make sure that you have the file "req.library" in your libs: directory!
  96. To run from CLI cd to the directory where YachtZ.snd, Dice.snd, and ty.high
  97. are stored and just simple type: ty<RETURN> And away you go! It will open
  98. an interlaced screen (Sorry, but the scorecard didn't fit nicely on a 
  99. non-interlaced screen) and a couple of windows. Maybe if you enjoy this 
  100. game so much and would really like to thank me you could send me a 
  101. flicker-fixer and a Multi-Sync monitor, so that I can play without the
  102. flicker, although it's not that bad... Just annoying! :-)
  103.  
  104. There are currently only 2 command line options:
  105.  
  106. ? - Gives you a list of command line options and will display the Version
  107.     number.
  108.     
  109. -s - Turns of sound for the ENTIRE game. (Disables the sound menu option).
  110.      This is useful if you are running low on chip (or Memory in general)
  111.      mem and don't want to load the 14K or so Dice.snd file into memory.
  112.  
  113. -d - Uses the default options                
  114.  
  115. -r - Causes the program to forget about using the Requester library to save
  116.      memory
  117.      
  118.      
  119.                      
  120.                 THE GAME
  121.  
  122. I'm not going to go into the rules of Yacht as it's a pretty widely known
  123. game. If you don't know about the basic game you can either buy the game
  124. Yahtzee by the E.S. Lowe Company, 200 5th Ave, NY, NY-10010, or get a
  125. copy of Hoyle's book of games (at least my old version had Yacht in it!)
  126.  
  127. Triple Yacht-Z differs form normal Yacht in that all scores in the 3rd 
  128. column of your scorecard are worth 3 times as much as the normal value, 
  129. those in the 2nd are worth double. Note that these values are only show as 
  130. doubled or tripled in the net score space, and NOT in the the individual 
  131. columns. The 35 Bonus Points for having at least the Average on the upper
  132. section is also doublable or triplable.
  133.  
  134. Each Yacht-Z after the 3rd is worth an extra 100 X Column used in. You MUST 
  135. score with the Yacht-Z to get these bonus points, if you score a 0 with it
  136. no bonus points will be rewarded.
  137.  
  138. In Single Yacht-Z after the first Yacht-Z each extra will be worth 100 
  139. points. These extra Yacht-Z's (unlike in Triple Yacht-Z) may be scored
  140. anywhere on the lower scoreboard (that still available!) or in the 
  141. appropriate upper space.
  142.  
  143. That's pretty much it for differences. There's no fancy fanfare for the 
  144. winner (maybe some later version...), he/she just get's his scorecard
  145. highlighted. The top 10 high scores for both Triple and Single Yacht-Z are 
  146. recorded so you can prove how well you did (Of course you could always edit
  147. the high score file... :-)) To reset the boards just delete the ty.high1
  148. or ty.high3 files!
  149.  
  150. The Single Yacht-Z game plays just like the Triple Yacht-Z game but there's
  151. only 1 column available to score. I only played it to make sure it works,
  152. but I included it for those who like the original game. Note the computer
  153. player strategy was geared towards the Triple Yacht-Z version, so don't
  154. cry to me if they don't play as well in Single Yacht-Z! 
  155.  
  156.  
  157.  
  158.                     MATCHES
  159.                     
  160. A match is a series of games (up to a maximum of 51 games). After each game
  161. the net score for each game as well as the Big Grand Total of all the nets
  162. will be displayed for each player, and the player inb the lead will be 
  163. highlighted. Using a match will allow you to even out the chance part of the
  164. game. Allowing you to recover from a game that you did really bad on.
  165.  
  166. While in match mode the current values for the number of players, and the
  167. game type (i.e. Triple or Single Yachtzee) will be taken from the current
  168. match settings rather than the Menu settings. So if you'd like to add a new
  169. player to the match, I'm sorry, you'll just have to start a new match.
  170. To play the next game in a match you must use the CONTINUE option from the
  171. match menu.
  172.  
  173. To get into match mode you must select either NEW MATCH or LOAD MATCH from
  174. the match menu. The only way to exit (without quitting the game completely)
  175. match mode is by using the NEW GAME option from the FILE menu. Once a match
  176. has been exitted by this means it is forgotten!!! So make sure you save the
  177. match before you select new game if you wish to continue it later!
  178.  
  179. NOTE: If the Req.Library is either disabled (see the -r flag) or unable to
  180. be openned Triple Yacht-Z will use "ty.match" for ALL loads and saves of
  181. game matches!
  182.  
  183.  
  184.  
  185.                     WINDOWS
  186.  
  187. Score Card - This is where you will be placing your scores.
  188.  
  189. Dice Table - This is where the dice are rolled, and the roll and score
  190.          gadgets are located.            
  191.          
  192. Computer Moves - This is where the computer will let you spy on what it is
  193.          doing. You can use the slider to adjust the speed at which
  194.          he rolls.
  195.          
  196. High Score - This is where the Triple Yacht-Z champions are immortalized!
  197.          If the color of the player is red, then he is the computer.
  198.          
  199.                     
  200.         
  201.                 MENUS AND GADGETS
  202.  
  203. The spaces in the Player column are actually string gadgets!!! To give a
  204. name to the player just simple click on the space and enter your name.
  205.  
  206. To give the computer a chance to have fun as well, just make sure the first
  207. 4 characters of the players name (under the column you want the computer
  208. to control) are "COMP" (This isn't case sensitive). Computer opponents will
  209. be save as "COMPUTER" and highlighted in red on the high score list. If
  210. your name happens to be Compton or some such, then I'm sorry, because if
  211. you enter that as your name the computer will want to play for you...
  212. I'm not claiming the Computer is that good of an opponent as this was my
  213. first attempt at writing code for a computer opponent, but with good roles
  214. it can beat you! :-)
  215.  
  216. The names can be changed at any time in the game. So if you're playing
  217. against four friends, and the third decides he's losing too badly and quits,
  218. you can always change his name to "COMPUTER", and let the computer finish 
  219. for him. Then he can always blame the computer for losing the game. This
  220. can also be used if you have computers playing against themselves and 
  221. decide that your memory could be put to better use. You can change one of
  222. the computer oppenents names so that it would no longer be in control and
  223. allow you to quit the game. Of course if I was the computer and you so 
  224. rudely interuppted one of my games, I'd probable do GURU on you...
  225.  
  226. The FAST-SLOW Slider Gadget allows you to alter the speed of the copmuter
  227. display. If you'd like to watch what the computer is rolling at a nice
  228. leisurely pace, just shift the knob all the way to right. If you don't give
  229. a darn what the computer is doing put it on the left and it'll zip on 
  230. throught it's turn. It's kind of fun to put it at this speed, turn off the
  231. sound, and then what four computer players play...
  232.  
  233. To roll click on those dice you'd like to keep. These will be highlighted 
  234. by a box drawn around them. Then clock on the ROLL gadget, and those dice
  235. without a box around them will be re-rolled.
  236.  
  237. The program will politely show you all the places where you could possible 
  238. place your roll in red. The numbers in the spaces are the number of points 
  239. that would be received for choosing that space. To choose a space just click 
  240. on it (you can do this at anytime during you turn). Now that was easy wasn't 
  241. it?
  242.  
  243. That's pretty much the normal operation of the game. Now lets hop to the
  244. menu choices.
  245.  
  246. FILE
  247.     
  248.     NEW - If the game is waiting for a game to start this will start it
  249.           immediately. If a game is already in progress, Triple Yacht-Z
  250.           will give you a chance to confirm you really want to be a 
  251.           quitter before starting another game. When a game starts the
  252.           number of players is determined by the current location of 
  253.           the checkmark under the players menu. NOTE: The use of this
  254.           way to start a game will automatically stop any match in 
  255.           progress. But You'll be warned if this is the case.
  256.           
  257.     END GAME - Using this option will end the current game if you so
  258.            verify.  You are then free to select a new match or
  259.            some other such option. 
  260.         
  261.     QUIT - This will of course be the least used option in the whole
  262.            game. (Clicking on the Close Window gadget on the Score Card
  263.            window will produce the same results) You will then be given
  264.            the option to correct your obviously mistaken attempt to 
  265.            do something else more productive.
  266.            
  267.     ABOUT - This is just here because everyone else does it, and it
  268.         lets me give my ego a little boost. Seeing my name in it 
  269.         and all... :-)
  270.         
  271.     SAVE PREFS - This will auto-magically add the current window
  272.              locations (or lack thereof as in the case of a closed
  273.              high-score window), and the Computer Speed, sound, 
  274.              number of players, and game type settings to the 
  275.              ty.prefs file. The old file will be deleted if it
  276.              existed!
  277.            
  278.     HIGH SCORES - If the high score window has been closed this will
  279.               re-open it for you. Isn't that special?
  280.               
  281.     COMPUTER - Does the same thing as HIGH SCORES except it opens the
  282.            Computer Moves window.
  283.            
  284.     PLAYERS
  285.     
  286.     You can select the number of players you want in the game by
  287.     choosing the correct item. This value is only read at a new game
  288.     attempt.
  289.     
  290. MISC
  291.  
  292.     UNDO - Lets you UNDO one move. You can't UNDO a computer move. 
  293.            You can also use this to cheat by giving you another chance
  294.            to roll that extra 4 you needed to get a yacht-Z.
  295.            WARNING: Only do this if your opponents are looking the other 
  296.            way! As I said before, I'll take no responsibility for your
  297.            friends beating you up because you cheated. But then if your
  298.            already big (such as a linebacker or such) then why not?!?!
  299.            Although it's probably good ettiquete to make sure that all
  300.            the rest of the players allow your use of the UNDO function
  301.            because you want to be fair right?!?!?
  302.     SOUND - This is a toggle. If there is a checkmark next to this item
  303.         you will be able to hear the astounding sound effects. If
  304.         not then you can enjoy the sounds of silence. If this item
  305.         is ghosted then that means there was an error allocating a 
  306.         sound channel, couldn't find the Dice.snd, or some other 
  307.         fatal sound problem, and you will not be given the
  308.         opportunity to listen to the sound until after you quit
  309.         and restart. 
  310.         NOTE: Turning the sound off will considerably speed up the
  311.         game as it won't have to play the dice rolling sound each
  312.         times it rolls. So if you wanted to get into the Guiness
  313.         Book of World Records for playing the most Triple Yacht-Z
  314.         games in an hour, this is the option for you!
  315.  
  316.     PALETTE - This calls up a color requester to allow you to alter the
  317.               colors to your own choosing!
  318.         
  319. VERSION
  320.     
  321.     SINGLE YACHT-Z - Use the Single Yacht-Z rules
  322.     
  323.     TRIPLE YACHT-Z - Use the Triple Yacht-Z rules
  324.     
  325.     Note that the current value of this menu is only checked at the
  326.     start of a new game. So don't expect to screw your opponnent 
  327.     over by switching to Single Yacht-Z when he gets up to go get
  328.     a Coke. (Note Coke is a Trademark of the Cocoa-Cola company. But
  329.     we all know that <real> programmers drink Jolt. :-))
  330.         
  331. MATCH
  332.     
  333.     (NOTE: This menu will only be active while the computer is waiting)
  334.     (for a new game to start. Thus if you are in the middle of a game )
  335.     (And you friend drops by to continue your match you'll have to use)
  336.     (END GAME to be able to access this menu!              )
  337.     
  338.     NEW MATCH - This will start a new Match for you.
  339.     
  340.     CONTINUE - This will start the next game in the match.
  341.     
  342.     LOAD MATCH - This will load the currently saved match and allow you
  343.              to CONTINUE where you left off.
  344.              
  345.     SAVE MATCH - This save the current match so you can come back and
  346.              play later.
  347.              
  348.              
  349.              
  350.                 PREFERENCES
  351.  
  352. The ty.prefs file consists 3 Letter mnenomics (is that how it's spelled?)
  353. starting on the first character of a new line. Their arguments follow
  354. directly. This was done as a quick-and-dirty type implemtation, and isn't
  355. really forgiving on format. Don't leave any blank lines because that will
  356. make it cause you trouble!
  357.  
  358. MNENOMIC
  359. COL
  360.     This will change the default colors.
  361.     Each subsequent hexadecimal digit will be assigned to the following
  362.     locations. (Note white space is ignored!)
  363.     1st - Color to Change (Range of 0-3)
  364.     2nd - Red Value
  365.     3rd - Green Value
  366.     4th - Blue Value
  367.     
  368.     EXAMPLE:
  369.         COL0F0F 
  370.         
  371.         This will set color 0 to a purple color (15 bits of Red,
  372.         0 Bits of Green, and 15 bits of Blue)
  373.  
  374. WIN
  375.     The first int read in is the window number which refer to the
  376.     following:
  377.     
  378.     0 - ScoreBoard Window
  379.     1 - Dice Window
  380.     2 - High Score Window
  381.     3 - Computer Moves Window
  382.     
  383.     the next two integers will be the x,y pixel locations of the upper
  384.     left corner of the window. If the value supplied will put the 
  385.     window over the edge of the window, a maximum value will be 
  386.     substituted. All number here must be seperated by a non-digit
  387.     character!
  388.     
  389. NOS
  390.     Means start game without openning the high score window.
  391.  
  392. NOC
  393.     Means start game without openning the computer move window.
  394.  
  395. END
  396.     This signifies the end of the prefs file. If you don't use this
  397.     you'll get an error message, but all previously accepted commands
  398.     will be used.        
  399.                 
  400. SND
  401.     The next character immediately following the directive will be the
  402.     current setting of the sound flag. The settings available are:
  403.     0 - Sound is Turned OFF
  404.     1 - Sound is Turned ON
  405.     2 - Sound is out for the rest of the game. (As in the -s runtime
  406.         flag
  407.                 
  408. SPD
  409.     The integer following this command will be the current percentage
  410.     of full delay for the computer. The integer must be in the range
  411.     of 0 and 65535 (where 65535 = 100% and 0 = 0%). The higher this
  412.     number the slower the computer display will be! It's probably best
  413.     to just slide the knob where you want it and then use the save
  414.     prefs command.
  415.          
  416. PLY
  417.     The number immediately following the dirrective will be the number
  418.     of players to start with
  419.     
  420. GAM
  421.     The number immediately following this directive will be the current
  422.     value of the game type flag. Current available settings are:
  423.     0 - Single Yacht-Z
  424.     1 - Triple Yacht-Z
  425.                 
  426.                 
  427.                 
  428.                 UPDATES!!!
  429.                 
  430. Gee I actually added an Update section to the docs! And I didn't even
  431. expect to get past v1.0!
  432.  
  433. V1.1 -
  434.     -Adds the Version #'s to the Triple Yacht-Z Screen's Title Bar
  435.     -Added the Version # to the Documentation!
  436.     -Now uses a 4 color hi-res interlaced screen instead of an eight
  437.      color screen. (Saves some chip mem!)
  438.     -Put in a Single Yacht-Z version for those who want to play the
  439.      single version!
  440.     -Added the ty.prefs file for those who want to customize their
  441.      own Triple Yacht-Z tables!
  442.     -Now highlights the winner.     
  443.     -Close Gadgets added to Computer and High Score Window in case you
  444.      want to run a real lean version
  445.     -There is now (Guess there couldn't have been before!) a seperate
  446.      highscore list for both single and triple Yacht-Z.     
  447.     -Fixed a bug whereby if you clicked on the roll gadget twice in a
  448.      row on your third roll, it would score some wierd value. All in 
  449.      all it wasn't very nice so I fixed it! :-)     
  450.     -Fixed a rather nasty bug whereby in certain circumstances the
  451.      computer would score a four of a kind in a space that was already
  452.      filled. This would leave a blank score after all was said and done.
  453.      Sorry about that one!
  454.     -Fixed something that could be considered a feature but I don't 
  455.      think so, so I "fixed" it. If the computer had a Yacht-Z available
  456.      and all the 3 and 4 of a kinds, as well as the applicable upper
  457.      score available, the computer would re-roll even if it had at
  458.      least two of kind...  
  459.     -Added a match menu so you can play series of games and tabulate
  460.      the scores!                    
  461.  
  462. V1.2 -
  463.     -Updated this DOC file again... :-)
  464.     -Fixed a bug (I hope) whereby points for extra yacht-z's were given
  465.      which weren't deserved.
  466.     -Fixed the "bug" whereby the bonus for >= average on the upper
  467.      scorecard is now 35 instead of 32.
  468.     -Fixed a couple undo function bugs (I told you there were some!) Of
  469.      course with some of the changes I made this required a re-write of
  470.      the undo stuff so I may have inserted some more! :-)
  471.     -Fixed a bug in the high score routines where if there was no high
  472.      score file when TY tried to load it save any current high scores
  473.      over that list...
  474.     -Fixed a bug whereby Bonus points for extra Yacht-Z's where not
  475.      removed after an undo...
  476.     -The scoreing possibilities of extra yacht-z's in the single yacht-z
  477.      game have been altered. Basically you now get the normal score for
  478.      lower scores and can only score an extra yacht-z in upper section
  479.      if it will "fit"
  480.     -Changed the dice window so that only the roll gadget remains. You
  481.      can click at anytime in the scorecard to score your roll! (My 
  482.      brother's idea.)
  483.     -Undo will now allow you to undo the last move just before the last
  484.      computer player. For example if you're playing against the
  485.      computer and you score a Yacht-Z as a scrath on the upper score
  486.      board you can undo that as soon as the copmuter has finished his
  487.      moves. Play will then continue with whoever was playing before
  488.      the undo was used. 
  489.     -Thanks to Colin Fox and Bruce Dawson's excellent requester library
  490.      (I didn't feel like making one! whew!) we now have a pallete
  491.      requester to allow you to alter your colors without editting the
  492.      ty.prefs file. Makes altering your scoring table a H*ll of alot
  493.      easier!
  494.     -Also thanks to the requester lib save and load match will now let
  495.      you use a requester to save your matches as whatever you want!
  496.     -Added a command line switch to avoid loading the Requester Library
  497.      in case you don't want to use anymore memory!
  498.     -Save Prefs now save the current color information because there's
  499.      now a way to easily change the colors during play.
  500.     -NOTE:Save Prefs nows deletes the old "ty.prefs" file and save the 
  501.      new one on top of it!
  502.     -I don't know when I'll get around to releasing a new version, the
  503.      only reason I'm releasing this is because there were some really
  504.      bad bugs lying around that I was kind of embarassed of. So if 
  505.      you've got a neat idea or feature you'd like to see me implement,
  506.      or God forbid another bug, send me a note. If I get enough requests 
  507.      I'll do another version, although currently I'm working on an even
  508.      neater project, a Dungeon construction kit for (Actually tools for
  509.      making one) along the lines of the Wizardry Genre... Although you'd
  510.      better give me a couple months on that one!      
  511.      
  512.      
  513.      
  514.                 CREDITS
  515.  
  516. This program was Written by Me: Stephan Iannce
  517.  
  518. Special Thanks goes to Colin Fox (Pyramyd Designs) & Bruce Dawson (of 
  519. CygnusSoft Software) for their wonderful ReqLibrary of which Version 2.5 is
  520. used here. 
  521.  
  522. Playtester: F Brian Iannce (He wanted his name in the docs... :-))
  523.  
  524. You can get in touch with me about improvements, bugs, or just to chat ( I
  525. like getting mail! (Seems like a lot of people do!)) through my UN*X
  526. account:
  527.     
  528.     siannce@polyslo.CalPoly.edu
  529.  
  530.  
  531. or through Snail Mail:
  532.  
  533. Stephan Iannce
  534. 173 Buena Vista Ave
  535. San Luis Obispo, CA 93405
  536.  
  537. Feel free to send donations ($5 or so), suggestions for additions or
  538. improvements, or bug reports!
  539.  
  540. Thanks for using my program! Until next time! (Hey! That's a incomplete
  541. sentance!)
  542.  
  543.     
  544.